/*
 * contrib/tablefunc/tablefunc.c
 *
 *
 * tablefunc
 *
 * 示例以演示返回 scalar 和 composite 集合的 C 函数。
 * Joe Conway <mail@joeconway.com>
 * 及贡献者：
 * Nabil Sayegh <postgresql@e-trolley.de>
 *
 * Copyright (c) 2002-2022, PostgreSQL Global Development Group
 *
 * Permission to use, copy, modify, and distribute this software and
 * its documentation for any purpose, without fee, and without a written agreement
 * is hereby granted, provided that the above copyright notice and this
 * paragraph and the following two paragraphs appear in all copies.
 *
 * IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY FOR
 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING
 * LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS
 * DOCUMENTATION, EVEN IF THE AUTHOR OR DISTRIBUTORS HAVE BEEN ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND THE AUTHOR AND DISTRIBUTORS HAS NO OBLIGATIONS TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 *
 */
#include "postgres.h"

#include <math.h>

#include "access/htup_details.h"
#include "catalog/pg_type.h"
#include "common/pg_prng.h"
#include "executor/spi.h"
#include "funcapi.h"
#include "lib/stringinfo.h"
#include "miscadmin.h"
#include "tablefunc.h"
#include "utils/builtins.h"

PG_MODULE_MAGIC;

static HTAB *fc_load_categories_hash(char *fc_cats_sql, MemoryContext fc_per_query_ctx);
static Tuplestorestate *fc_get_crosstab_tuplestore(char *fc_sql,
												HTAB *fc_crosstab_hash,
												TupleDesc fc_tupdesc,
												bool fc_randomAccess);
static void fc_validateConnectbyTupleDesc(TupleDesc fc_tupdesc, bool fc_show_branch, bool fc_show_serial);
static bool fc_compatCrosstabTupleDescs(TupleDesc fc_tupdesc1, TupleDesc fc_tupdesc2);
static void fc_compatConnectbyTupleDescs(TupleDesc fc_tupdesc1, TupleDesc fc_tupdesc2);
static void fc_get_normal_pair(float8 *fc_x1, float8 *fc_x2);
static Tuplestorestate *fc_connectby(char *fc_relname,
								  char *fc_key_fld,
								  char *fc_parent_key_fld,
								  char *fc_orderby_fld,
								  char *fc_branch_delim,
								  char *fc_start_with,
								  int fc_max_depth,
								  bool fc_show_branch,
								  bool fc_show_serial,
								  MemoryContext fc_per_query_ctx,
								  bool fc_randomAccess,
								  AttInMetadata *fc_attinmeta);
static void fc_build_tuplestore_recursively(char *fc_key_fld,
										 char *fc_parent_key_fld,
										 char *fc_relname,
										 char *fc_orderby_fld,
										 char *fc_branch_delim,
										 char *fc_start_with,
										 char *fc_branch,
										 int fc_level,
										 int *fc_serial,
										 int fc_max_depth,
										 bool fc_show_branch,
										 bool fc_show_serial,
										 MemoryContext fc_per_query_ctx,
										 AttInMetadata *fc_attinmeta,
										 Tuplestorestate *fc_tupstore);

typedef struct
{
	float8		mean;			/* 分布的均值 */
	float8		stddev;			/* 分布的标准差 */
	float8		carry_val;		/* 保存第二个生成的值 */
	bool		use_carry;		/* 使用第二个生成的值 */
} normal_rand_fctx;

#define xpfree(var_) \
	do { \
		if (var_ != NULL) \
		{ \
			pfree(var_); \
			var_ = NULL; \
		} \
	} while (0)

#define xpstrdup(tgtvar_, srcvar_) \
	do { \
		if (srcvar_) \
			tgtvar_ = pstrdup(srcvar_); \
		else \
			tgtvar_ = NULL; \
	} while (0)

#define xstreq(tgtvar_, srcvar_) \
	(((tgtvar_ == NULL) && (srcvar_ == NULL)) || \
	 ((tgtvar_ != NULL) && (srcvar_ != NULL) && (strcmp(tgtvar_, srcvar_) == 0)))

/* 符号，10位数字，'\0' */
#define INT32_STRLEN	12

/* 某个交叉表类别的存储信息 */
typedef struct crosstab_cat_desc
{
	char	   *catname;		/* 完整类别名称 */
	uint64		attidx;			/* 从零开始 */
} crosstab_cat_desc;

#define MAX_CATNAME_LEN			NAMEDATALEN
#define INIT_CATS				64

#define crosstab_HashTableLookup(HASHTAB, CATNAME, CATDESC) \
do { \
	crosstab_HashEnt *fc_hentry; char fc_key[MAX_CATNAME_LEN]; \
	\
	MemSet(fc_key, 0, MAX_CATNAME_LEN); \
	snprintf(fc_key, MAX_CATNAME_LEN - 1, "%s", CATNAME); \
	fc_hentry = (crosstab_HashEnt*) hash_search(HASHTAB, \
										 fc_key, HASH_FIND, NULL); \
	if (fc_hentry) \
		CATDESC = fc_hentry->catdesc; \
	else \
		CATDESC = NULL; \
} while(0)

#define crosstab_HashTableInsert(HASHTAB, CATDESC) \
do { \
	crosstab_HashEnt *fc_hentry; bool fc_found; char fc_key[MAX_CATNAME_LEN]; \
	\
	MemSet(fc_key, 0, MAX_CATNAME_LEN); \
	snprintf(fc_key, MAX_CATNAME_LEN - 1, "%s", CATDESC->catname); \
	fc_hentry = (crosstab_HashEnt*) hash_search(HASHTAB, \
										 fc_key, HASH_ENTER, &fc_found); \
	if (fc_found) \
		ereport(ERROR, \
				(errcode(ERRCODE_DUPLICATE_OBJECT), \
				 errmsg("duplicate category name"))); \
	fc_hentry->catdesc = CATDESC; \
} while(0)

/* 哈希表 */
typedef struct crosstab_hashent
{
	char		internal_catname[MAX_CATNAME_LEN];
	crosstab_cat_desc *catdesc;
} crosstab_HashEnt;

/*
 * normal_rand - 返回请求的随机值数量
 * 具有高斯（正态）分布。
 *
 * 输入参数为 int numvals，float8 mean，和 float8 stddev
 * 返回 setof float8
 */
PG_FUNCTION_INFO_V1(normal_rand);
Datum normal_rand(PG_FUNCTION_ARGS)
{
	FuncCallContext *fc_funcctx;
	uint64		fc_call_cntr;
	uint64		fc_max_calls;
	normal_rand_fctx *fc_fctx;
	float8		fc_mean;
	float8		fc_stddev;
	float8		fc_carry_val;
	bool		fc_use_carry;
	MemoryContext fc_oldcontext;

	/* 仅在函数的第一次调用时完成的工作 */
	if (SRF_IS_FIRSTCALL())
	{
		int32		fc_num_tuples;

		/* 为跨调用持久性创建一个函数上下文 */
		fc_funcctx = SRF_FIRSTCALL_INIT();

		/*
		 * 切换到适合多次函数调用的内存上下文
		 */
		fc_oldcontext = MemoryContextSwitchTo(fc_funcctx->multi_call_memory_ctx);

		/* 要返回的元组总数 */
		fc_num_tuples = PG_GETARG_INT32(0);
		if (fc_num_tuples < 0)
			ereport(ERROR,
					(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
					 errmsg("number of rows cannot be negative")));
		fc_funcctx->max_calls = fc_num_tuples;

		/* 为用户上下文分配内存 */
		fc_fctx = (normal_rand_fctx *) palloc(sizeof(normal_rand_fctx));

		/*
		 * 使用 fctx 跟踪从一次调用到下一次调用的上限和下限。
		 * 它还将用于携带我们从 Box-Muller 算法中获得的备用值，
		 * 这样我们每次只实际计算一个新值。
		 */
		fc_fctx->mean = PG_GETARG_FLOAT8(1);
		fc_fctx->stddev = PG_GETARG_FLOAT8(2);
		fc_fctx->carry_val = 0;
		fc_fctx->use_carry = false;

		fc_funcctx->user_fctx = fc_fctx;

		MemoryContextSwitchTo(fc_oldcontext);
	}

	/* 每次调用函数时完成的工作 */
	fc_funcctx = SRF_PERCALL_SETUP();

	fc_call_cntr = fc_funcctx->call_cntr;
	fc_max_calls = fc_funcctx->max_calls;
	fc_fctx = fc_funcctx->user_fctx;
	fc_mean = fc_fctx->mean;
	fc_stddev = fc_fctx->stddev;
	fc_carry_val = fc_fctx->carry_val;
	fc_use_carry = fc_fctx->use_carry;

	if (fc_call_cntr < fc_max_calls)	/* 当还有更多内容要发送时执行 */
	{
		float8		fc_result;

		if (fc_use_carry)
		{
			/*
			 * 重置 use_carry，并使用上次传递中获得的第二个值
			 */
			fc_fctx->use_carry = false;
			fc_result = fc_carry_val;
		}
		else
		{
			float8		fc_normval_1;
			float8		fc_normval_2;

			/* 获取下两个正态值 */
			fc_get_normal_pair(&fc_normval_1, &fc_normval_2);

			/* 使用第一个 */
			fc_result = fc_mean + (fc_stddev * fc_normval_1);

			/* 并保存第二个 */
			fc_fctx->carry_val = fc_mean + (fc_stddev * fc_normval_2);
			fc_fctx->use_carry = true;
		}

		/* 发送结果 */
		SRF_RETURN_NEXT(fc_funcctx, Float8GetDatum(fc_result));
	}
	else
		/* 当没有更多内容时执行 */
		SRF_RETURN_DONE(fc_funcctx);
}

/*
 * get_normal_pair()
 * 将正态分布（高斯）值分配给一对提供的
 * 参数，均值为 0，标准差为 1。
 *
 * 此例程实现了 Knuth 的《计算机程序设计艺术》第 2 卷，第 3 版，页面
 * 122-126 中的 P 算法（正态变数的极坐标方法）。
 * Knuth 引用的来源是 “极坐标方法”，G. E. P. Box，M. E.
 * Muller 和 G. Marsaglia，_Annals_Math,_Stat._ 29 (1958), 610-611。
 *
 */
static void fc_get_normal_pair(float8 *fc_x1, float8 *fc_x2)
{
	float8		fc_u1,
				fc_u2,
				fc_v1,
				fc_v2,
				fc_s;

	do
	{
		fc_u1 = pg_prng_double(&pg_global_prng_state);
		fc_u2 = pg_prng_double(&pg_global_prng_state);

		fc_v1 = (2.0 * fc_u1) - 1.0;
		fc_v2 = (2.0 * fc_u2) - 1.0;

		fc_s = fc_v1 * fc_v1 + fc_v2 * fc_v2;
	} while (fc_s >= 1.0);

	if (fc_s == 0)
	{
		*fc_x1 = 0;
		*fc_x2 = 0;
	}
	else
	{
		fc_s = sqrt((-2.0 * log(fc_s)) / fc_s);
		*fc_x1 = fc_v1 * fc_s;
		*fc_x2 = fc_v2 * fc_s;
	}
}

/*
 * crosstab - 创建一个交叉表，将行标识符和来自SQL语句的值列
 * 返回一列行标识符、一列类别和一列值。
 *
 * 例如，给定产生以下结果的SQL：
 *
 *			rowid	cat		value
 *			------+-------+-------
 *			row1	cat1	val1
 *			row1	cat2	val2
 *			row1	cat3	val3
 *			row1	cat4	val4
 *			row2	cat1	val5
 *			row2	cat2	val6
 *			row2	cat3	val7
 *			row2	cat4	val8
 *
 * crosstab 返回：
 *					<===== 值列 =====>
 *			rowid	cat1	cat2	cat3	cat4
 *			------+-------+-------+-------+-------
 *			row1	val1	val2	val3	val4
 *			row2	val5	val6	val7	val8
 *
 * 注释：
 * 1. SQL 结果必须按 1,2 排序。
 * 2. 值列的数量取决于函数声明的返回类型的元组描述。
 *	  返回类型的列必须与 SQL 查询的结果的数据类型相匹配。不过，
 *	  类别列的数据类型可以是任何类型。
 * 3. 缺失值（即，邻接的相同行标识符的行数不足以填充结果值列的数量）
 *	  被填充为 null。
 * 4. 额外值（即，邻接的相同行标识符的行数过多，无法填满结果值列的数量）
 *	  被跳过。
 * 5. 在值列中所有值均为 null 的行被跳过。
 */
PG_FUNCTION_INFO_V1(crosstab);
Datum crosstab(PG_FUNCTION_ARGS)
{
	char	   *fc_sql = text_to_cstring(PG_GETARG_TEXT_PP(0));
	ReturnSetInfo *fc_rsinfo = (ReturnSetInfo *) fcinfo->resultinfo;
	Tuplestorestate *fc_tupstore;
	TupleDesc	fc_tupdesc;
	uint64		fc_call_cntr;
	uint64		fc_max_calls;
	AttInMetadata *fc_attinmeta;
	SPITupleTable *fc_spi_tuptable;
	TupleDesc	fc_spi_tupdesc;
	bool		fc_firstpass;
	char	   *fc_lastrowid;
	int			fc_i;
	int			fc_num_categories;
	MemoryContext fc_per_query_ctx;
	MemoryContext fc_oldcontext;
	int			fc_ret;
	uint64		fc_proc;

	/* 检查调用者是否支持我们返回 tupplestore */
	if (fc_rsinfo == NULL || !IsA(fc_rsinfo, ReturnSetInfo))
		ereport(ERROR,
				(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
				 errmsg("set-valued function called in context that cannot accept a set")));
	if (!(fc_rsinfo->allowedModes & SFRM_Materialize))
		ereport(ERROR,
				(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
				 errmsg("materialize mode required, but it is not allowed in this context")));

	fc_per_query_ctx = fc_rsinfo->econtext->ecxt_per_query_memory;

	/* 连接到 SPI 管理器 */
	if ((fc_ret = SPI_connect()) < 0)
		/* 内部错误 */
		elog(ERROR, "crosstab: SPI_connect returned %d", fc_ret);

	/* 获取所需的行 */
	fc_ret = SPI_execute(fc_sql, true, 0);
	fc_proc = SPI_processed;

	/* 如果没有符合条件的元组，提前返回 */
	if (fc_ret != SPI_OK_SELECT || fc_proc == 0)
	{
		SPI_finish();
		fc_rsinfo->isDone = ExprEndResult;
		PG_RETURN_NULL();
	}

	fc_spi_tuptable = SPI_tuptable;
	fc_spi_tupdesc = fc_spi_tuptable->tupdesc;

	/*----------
	 * 提供的 SQL 查询必须始终返回三列。
	 *
	 * 1. 行名称
	 *	  最终结果中每行的标签或标识符
	 * 2. 类别
	 *	  最终结果中每列的标签或标识符
	 * 3. 值
	 *	  最终结果中每列的值
	 *----------
	 */
	if (fc_spi_tupdesc->natts != 3)
		ereport(ERROR,
				(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
				 errmsg("invalid source data SQL statement"),
				 errdetail("The provided SQL must return 3 "
						   "columns: rowid, category, and values.")));

	/* 获取我们的结果类型的元组描述符 */
	switch (get_call_result_type(fcinfo, NULL, &fc_tupdesc))
	{
		case TYPEFUNC_COMPOSITE:
			/* 成功 */
			break;
		case TYPEFUNC_RECORD:
			/* 未能确定 RECORD 的实际类型 */
			ereport(ERROR,
					(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
					 errmsg("function returning record called in context "
							"that cannot accept type record")));
			break;
		default:
			/* 结果类型不是复合类型 */
			ereport(ERROR,
					(errcode(ERRCODE_DATATYPE_MISMATCH),
					 errmsg("return type must be a row type")));
			break;
	}

	/*
	 * 检查返回的 tupdesc 是否与我们从 SPI 获取的数据兼容，
	 * 至少基于属性的数量和类型
	 */
	if (!fc_compatCrosstabTupleDescs(fc_tupdesc, fc_spi_tupdesc))
		ereport(ERROR,
				(errcode(ERRCODE_SYNTAX_ERROR),
				 errmsg("return and sql tuple descriptions are " \
						"incompatible")));

	/*
	 * 切换到长生命周期内存上下文
	 */
	fc_oldcontext = MemoryContextSwitchTo(fc_per_query_ctx);

	/* 确保我们有结果 tupdesc 的持久副本 */
	fc_tupdesc = CreateTupleDescCopy(fc_tupdesc);

	/* 在长生命周期上下文中初始化我们的元组存储 */
	fc_tupstore =
		tuplestore_begin_heap(fc_rsinfo->allowedModes & SFRM_Materialize_Random,
							  false, work_mem);

	MemoryContextSwitchTo(fc_oldcontext);

	/*
	 * 生成稍后从原始C字符串生成元组所需的属性元数据
	 */
	fc_attinmeta = TupleDescGetAttInMetadata(fc_tupdesc);

	/* 要检查的元组总数 */
	fc_max_calls = fc_proc;

	/* 返回的元组必须始终具有 1 列行标识符 + 类别数量列 */
	fc_num_categories = fc_tupdesc->natts - 1;

	fc_firstpass = true;
	fc_lastrowid = NULL;

	for (fc_call_cntr = 0; fc_call_cntr < fc_max_calls; fc_call_cntr++)
	{
		bool		fc_skip_tuple = false;
		char	  **fc_values;

		/* 分配并归零空间 */
		fc_values = (char **) palloc0((1 + fc_num_categories) * sizeof(char *));

		/*
		 * 现在循环遍历 SQL 结果，并按顺序将每个值分配给下一个类别
		 */
		for (fc_i = 0; fc_i < fc_num_categories; fc_i++)
		{
			HeapTuple	fc_spi_tuple;
			char	   *fc_rowid;

			/* 查看我们是否已经走得太远 */
			if (fc_call_cntr >= fc_max_calls)
				break;

			/* 获取下一个 SQL 结果元组 */
			fc_spi_tuple = fc_spi_tuptable->vals[fc_call_cntr];

			/* 从当前 SQL 结果元组中获取行标识符 */
			fc_rowid = SPI_getvalue(fc_spi_tuple, fc_spi_tupdesc, 1);

			/*
			 * 如果这是该行标识符的值的第一次遍历，
			 * 将第一列设置为行标识符
			 */
			if (fc_i == 0)
			{
				xpstrdup(fc_values[0], fc_rowid);

				/*
				 * 检查行标识符是否与最后发送的元组相同 -- 如果相同，完全跳过此元组
				 */
				if (!fc_firstpass && xstreq(fc_lastrowid, fc_rowid))
				{
					xpfree(fc_rowid);
					fc_skip_tuple = true;
					break;
				}
			}

			/*
			 * 如果行标识符没有改变，继续构建输出元组。
			 */
			if (xstreq(fc_rowid, fc_values[0]))
			{
				/*
				 * 获取下一个类别项值，始终是属性编号三。
				 *
				 * 小心根据我们当前处理的类别将值分配给数组索引。
				 */
				fc_values[1 + fc_i] = SPI_getvalue(fc_spi_tuple, fc_spi_tupdesc, 3);

				/*
				 * 增加计数器，因为我们为每个类别消耗一行，但最后一次传递不算，因为外部循环会为我们处理。
				 */
				if (fc_i < (fc_num_categories - 1))
					fc_call_cntr++;
				xpfree(fc_rowid);
			}
			else
			{
				/*
				 * 我们将为缺失的值填充NULL，但需要递减计数器，因为此SQL结果行不属于当前输出元组。
				 */
				fc_call_cntr--;
				xpfree(fc_rowid);
				break;
			}
		}

		if (!fc_skip_tuple)
		{
			HeapTuple	fc_tuple;

			/* 构建元组并存储它 */
			fc_tuple = BuildTupleFromCStrings(fc_attinmeta, fc_values);
			tuplestore_puttuple(fc_tupstore, fc_tuple);
			heap_freetuple(fc_tuple);
		}

		/* 记住当前行标识符 */
		xpfree(fc_lastrowid);
		xpstrdup(fc_lastrowid, fc_values[0]);
		fc_firstpass = false;

		/* 清理 */
		for (fc_i = 0; fc_i < fc_num_categories + 1; fc_i++)
			if (fc_values[fc_i] != NULL)
				pfree(fc_values[fc_i]);
		pfree(fc_values);
	}

	/* 让调用者知道我们正在返回一个元组存储 */
	fc_rsinfo->returnMode = SFRM_Materialize;
	fc_rsinfo->setResult = fc_tupstore;
	fc_rsinfo->setDesc = fc_tupdesc;

	/* 释放与SPI相关的资源（并返回到调用者的上下文） */
	SPI_finish();

	return (Datum) 0;
}

/*
 * crosstab_hash - 重新实现crosstab作为物化函数，并
 * 正确处理缺失值（即，不将剩余值打包到左侧）
 *
 * crosstab - 从返回一个行标识符列、一个类别列和一个值列的SQL语句
 * 创建行标识符和值列的crosstab。
 *
 * 例如，给定生成的sql：
 *
 *			rowid	cat		value
 *			------+-------+-------
 *			row1	cat1	val1
 *			row1	cat2	val2
 *			row1	cat4	val4
 *			row2	cat1	val5
 *			row2	cat2	val6
 *			row2	cat3	val7
 *			row2	cat4	val8
 *
 * crosstab返回：
 *					<===== 值列 =====>
 *			rowid	cat1	cat2	cat3	cat4
 *			------+-------+-------+-------+-------
 *			row1	val1	val2	null	val4
 *			row2	val5	val6	val7	val8
 *
 * 注意：
 * 1. SQL结果必须按1排序。
 * 2. 值列的数量取决于函数声明的返回类型的元组描述。
 * 3. 缺失值（即缺失类别）用null填充。
 * 4. 多余的值（即不在类别结果中的）被跳过。
 */
PG_FUNCTION_INFO_V1(crosstab_hash);
Datum crosstab_hash(PG_FUNCTION_ARGS)
{
	char	   *fc_sql = text_to_cstring(PG_GETARG_TEXT_PP(0));
	char	   *fc_cats_sql = text_to_cstring(PG_GETARG_TEXT_PP(1));
	ReturnSetInfo *fc_rsinfo = (ReturnSetInfo *) fcinfo->resultinfo;
	TupleDesc	fc_tupdesc;
	MemoryContext fc_per_query_ctx;
	MemoryContext fc_oldcontext;
	HTAB	   *fc_crosstab_hash;

	/* 检查调用者是否支持我们返回 tupplestore */
	if (fc_rsinfo == NULL || !IsA(fc_rsinfo, ReturnSetInfo))
		ereport(ERROR,
				(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
				 errmsg("set-valued function called in context that cannot accept a set")));
	if (!(fc_rsinfo->allowedModes & SFRM_Materialize) ||
		fc_rsinfo->expectedDesc == NULL)
		ereport(ERROR,
				(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
				 errmsg("materialize mode required, but it is not allowed in this context")));

	fc_per_query_ctx = fc_rsinfo->econtext->ecxt_per_query_memory;
	fc_oldcontext = MemoryContextSwitchTo(fc_per_query_ctx);

	/* 获取请求的返回元组描述 */
	fc_tupdesc = CreateTupleDescCopy(fc_rsinfo->expectedDesc);

	/*
	 * 检查以确保我们拥有合理的元组描述
	 *
	 * 注意，我们将尝试将值强制转换为返回属性类型，并依赖于“in”函数在需要时进行投诉。
	 */
	if (fc_tupdesc->natts < 2)
		ereport(ERROR,
				(errcode(ERRCODE_SYNTAX_ERROR),
				 errmsg("query-specified return tuple and " \
						"crosstab function are not compatible")));

	/* 加载类别哈希表 */
	fc_crosstab_hash = fc_load_categories_hash(fc_cats_sql, fc_per_query_ctx);

	/* 让调用者知道我们正在返回一个元组存储 */
	fc_rsinfo->returnMode = SFRM_Materialize;

	/* 现在去构建它 */
	fc_rsinfo->setResult = fc_get_crosstab_tuplestore(fc_sql,
												fc_crosstab_hash,
												fc_tupdesc,
												fc_rsinfo->allowedModes & SFRM_Materialize_Random);

	/*
	 * SFRM_Materialize模式期望我们返回一个NULL Datum。实际
	 * 元组在我们的元组存储中，通过rsinfo->setResult返回。
	 * rsinfo->setDesc设置为我们实际用于构建元组的元组描述，
	 * 这样调用者可以验证我们所做的是否符合预期。
	 */
	fc_rsinfo->setDesc = fc_tupdesc;
	MemoryContextSwitchTo(fc_oldcontext);

	return (Datum) 0;
}

/*
 * 加载类别哈希表
 */
static HTAB * fc_load_categories_hash(char *fc_cats_sql, MemoryContext fc_per_query_ctx)
{
	HTAB	   *fc_crosstab_hash;
	HASHCTL		fc_ctl;
	int			fc_ret;
	uint64		fc_proc;
	MemoryContext fc_SPIcontext;

	/* 初始化类别哈希表 */
	fc_ctl.keysize = MAX_CATNAME_LEN;
	fc_ctl.entrysize = sizeof(crosstab_HashEnt);
	fc_ctl.hcxt = fc_per_query_ctx;

	/*
	 * 使用上面定义的 INIT_CATS 作为创建初始哈希表条目的数量的猜测
	 */
	fc_crosstab_hash = hash_create("crosstab hash",
								INIT_CATS,
								&fc_ctl,
								HASH_ELEM | HASH_STRINGS | HASH_CONTEXT);

	/* 连接到 SPI 管理器 */
	if ((fc_ret = SPI_connect()) < 0)
		/* 内部错误 */
		elog(ERROR, "load_categories_hash: SPI_connect returned %d", fc_ret);

	/* 检索类别名称行 */
	fc_ret = SPI_execute(fc_cats_sql, true, 0);
	fc_proc = SPI_processed;

	/* 检查符合条件的元组 */
	if ((fc_ret == SPI_OK_SELECT) && (fc_proc > 0))
	{
		SPITupleTable *fc_spi_tuptable = SPI_tuptable;
		TupleDesc	fc_spi_tupdesc = fc_spi_tuptable->tupdesc;
		uint64		fc_i;

		/*
		 * 提供的类别 SQL 查询必须始终返回一列：
		 * 类别 - 每列的标签或标识符
		 */
		if (fc_spi_tupdesc->natts != 1)
			ereport(ERROR,
					(errcode(ERRCODE_SYNTAX_ERROR),
					 errmsg("provided \"categories\" SQL must " \
							"return 1 column of at least one row")));

		for (fc_i = 0; fc_i < fc_proc; fc_i++)
		{
			crosstab_cat_desc *fc_catdesc;
			char	   *fc_catname;
			HeapTuple	fc_spi_tuple;

			/* 获取下一个 SQL 结果元组 */
			fc_spi_tuple = fc_spi_tuptable->vals[fc_i];

			/* 从当前 SQL 结果元组中获取类别 */
			fc_catname = SPI_getvalue(fc_spi_tuple, fc_spi_tupdesc, 1);
			if (fc_catname == NULL)
				ereport(ERROR,
						(errcode(ERRCODE_SYNTAX_ERROR),
						 errmsg("provided \"categories\" SQL must " \
								"not return NULL values")));

			fc_SPIcontext = MemoryContextSwitchTo(fc_per_query_ctx);

			fc_catdesc = (crosstab_cat_desc *) palloc(sizeof(crosstab_cat_desc));
			fc_catdesc->catname = fc_catname;
			fc_catdesc->attidx = fc_i;

			/* 将 proc 描述块添加到哈希表 */
			crosstab_HashTableInsert(fc_crosstab_hash, fc_catdesc);

			MemoryContextSwitchTo(fc_SPIcontext);
		}
	}

	if (SPI_finish() != SPI_OK_FINISH)
		/* 内部错误 */
		elog(ERROR, "load_categories_hash: SPI_finish() failed");

	return fc_crosstab_hash;
}

/*
 * 使用提供的源查询创建并填充交叉表元组存储
 */
static Tuplestorestate * fc_get_crosstab_tuplestore(char *fc_sql,
						HTAB *fc_crosstab_hash,
						TupleDesc fc_tupdesc,
						bool fc_randomAccess)
{
	Tuplestorestate *fc_tupstore;
	int			fc_num_categories = hash_get_num_entries(fc_crosstab_hash);
	AttInMetadata *fc_attinmeta = TupleDescGetAttInMetadata(fc_tupdesc);
	char	  **fc_values;
	HeapTuple	fc_tuple;
	int			fc_ret;
	uint64		fc_proc;

	/* 初始化我们的元组存储（仍在查询上下文中！） */
	fc_tupstore = tuplestore_begin_heap(fc_randomAccess, false, work_mem);

	/* 连接到 SPI 管理器 */
	if ((fc_ret = SPI_connect()) < 0)
		/* 内部错误 */
		elog(ERROR, "get_crosstab_tuplestore: SPI_connect returned %d", fc_ret);

	/* 现在检索交叉表源行 */
	fc_ret = SPI_execute(fc_sql, true, 0);
	fc_proc = SPI_processed;

	/* 检查符合条件的元组 */
	if ((fc_ret == SPI_OK_SELECT) && (fc_proc > 0))
	{
		SPITupleTable *fc_spi_tuptable = SPI_tuptable;
		TupleDesc	fc_spi_tupdesc = fc_spi_tuptable->tupdesc;
		int			fc_ncols = fc_spi_tupdesc->natts;
		char	   *fc_rowid;
		char	   *fc_lastrowid = NULL;
		bool		fc_firstpass = true;
		uint64		fc_i;
		int			fc_j;
		int			fc_result_ncols;

		if (fc_num_categories == 0)
		{
			/* 没有符合条件的类别元组 */
			ereport(ERROR,
					(errcode(ERRCODE_SYNTAX_ERROR),
					 errmsg("provided \"categories\" SQL must " \
							"return 1 column of at least one row")));
		}

		/*
		 * 提供的 SQL 查询必须始终返回至少三列：
		 *
		 * 1. rowname 行的标签 - 最终结果中的第 1 列
		 * 2. category 最终结果中每个值列的标签
		 * 3. value 填充值列的值
		 *
		 * 如果有超过三列，则最后两列被视为
		 * "类别" 和 "值"。第一列被视为 "行名"。
		 * 额外的列（2 到 N-2）假定对于相同的
		 * "行名" 是相同的，并从第一次
		 * 遇到特定的行名时复制到结果元组中。
		 */
		if (fc_ncols < 3)
			ereport(ERROR,
					(errcode(ERRCODE_INVALID_PARAMETER_VALUE),
					 errmsg("invalid source data SQL statement"),
					 errdetail("The provided SQL must return 3 " \
							   " columns; rowid, category, and values.")));

		fc_result_ncols = (fc_ncols - 2) + fc_num_categories;

		/* 重新检查以确保我们的元组描述符看起来合理 */
		if (fc_tupdesc->natts != fc_result_ncols)
			ereport(ERROR,
					(errcode(ERRCODE_SYNTAX_ERROR),
					 errmsg("invalid return type"),
					 errdetail("Query-specified return " \
							   "tuple has %d columns but crosstab " \
							   "returns %d.", fc_tupdesc->natts, fc_result_ncols)));

		/* 分配空间并确保其清晰 */
		fc_values = (char **) palloc0(fc_result_ncols * sizeof(char *));

		for (fc_i = 0; fc_i < fc_proc; fc_i++)
		{
			HeapTuple	fc_spi_tuple;
			crosstab_cat_desc *fc_catdesc;
			char	   *fc_catname;

			/* 获取下一个 SQL 结果元组 */
			fc_spi_tuple = fc_spi_tuptable->vals[fc_i];

			/* 从当前 SQL 结果元组中获取行标识符 */
			fc_rowid = SPI_getvalue(fc_spi_tuple, fc_spi_tupdesc, 1);

			/*
			 * 如果我们在一个新的输出行上，现在获取列值直到
			 * 列 N-2
			 */
			if (fc_firstpass || !xstreq(fc_lastrowid, fc_rowid))
			{
				/*
				 * 新行意味着我们需要先刷新旧行，除非
				 * 我们在第一行
				 */
				if (!fc_firstpass)
				{
					/* 行 ID 发生变化，刷新前一个输出行 */
					fc_tuple = BuildTupleFromCStrings(fc_attinmeta, fc_values);

					tuplestore_puttuple(fc_tupstore, fc_tuple);

					for (fc_j = 0; fc_j < fc_result_ncols; fc_j++)
						xpfree(fc_values[fc_j]);
				}

				fc_values[0] = fc_rowid;
				for (fc_j = 1; fc_j < fc_ncols - 2; fc_j++)
					fc_values[fc_j] = SPI_getvalue(fc_spi_tuple, fc_spi_tupdesc, fc_j + 1);

				/* 我们不再处于第一次通过中 */
				fc_firstpass = false;
			}

			/* 查找类别并填写适当的列 */
			fc_catname = SPI_getvalue(fc_spi_tuple, fc_spi_tupdesc, fc_ncols - 1);

			if (fc_catname != NULL)
			{
				crosstab_HashTableLookup(fc_crosstab_hash, fc_catname, fc_catdesc);

				if (fc_catdesc)
					fc_values[fc_catdesc->attidx + fc_ncols - 2] =
						SPI_getvalue(fc_spi_tuple, fc_spi_tupdesc, fc_ncols);
			}

			xpfree(fc_lastrowid);
			xpstrdup(fc_lastrowid, fc_rowid);
		}

		/* 刷新最后的输出行 */
		fc_tuple = BuildTupleFromCStrings(fc_attinmeta, fc_values);

		tuplestore_puttuple(fc_tupstore, fc_tuple);
	}

	if (SPI_finish() != SPI_OK_FINISH)
		/* 内部错误 */
		elog(ERROR, "get_crosstab_tuplestore: SPI_finish() failed");

	return fc_tupstore;
}

/*
 * connectby_text - 生成一个来自层次（父/子）表的结果集。
 *
 * 例如，给定表 foo：
 *
 *			keyid	parent_keyid pos
 *			------+------------+--
 *			row1	NULL		 0
 *			row2	row1		 0
 *			row3	row1		 0
 *			row4	row2		 1
 *			row5	row2		 0
 *			row6	row4		 0
 *			row7	row3		 0
 *			row8	row6		 0
 *			row9	row5		 0
 *
 *
 * connectby(text relname, text keyid_fld, text parent_keyid_fld
 *			  [, text orderby_fld], text start_with, int max_depth
 *			  [, text branch_delim])
 * connectby('foo', 'keyid', 'parent_keyid', 'pos', 'row2', 0, '~') 返回：
 *
 *		keyid	parent_id	level	 branch				serial
 *		------+-----------+--------+-----------------------
 *		row2	NULL		  0		  row2				  1
 *		row5	row2		  1		  row2~row5			  2
 *		row9	row5		  2		  row2~row5~row9	  3
 *		row4	row2		  1		  row2~row4			  4
 *		row6	row4		  2		  row2~row4~row6	  5
 *		row8	row6		  3		  row2~row4~row6~row8 6
 *
 */
PG_FUNCTION_INFO_V1(connectby_text);

#define CONNECTBY_NCOLS					4
#define CONNECTBY_NCOLS_NOBRANCH		3

Datum connectby_text(PG_FUNCTION_ARGS)
{
	char	   *fc_relname = text_to_cstring(PG_GETARG_TEXT_PP(0));
	char	   *fc_key_fld = text_to_cstring(PG_GETARG_TEXT_PP(1));
	char	   *fc_parent_key_fld = text_to_cstring(PG_GETARG_TEXT_PP(2));
	char	   *fc_start_with = text_to_cstring(PG_GETARG_TEXT_PP(3));
	int			fc_max_depth = PG_GETARG_INT32(4);
	char	   *fc_branch_delim = NULL;
	bool		fc_show_branch = false;
	bool		fc_show_serial = false;
	ReturnSetInfo *fc_rsinfo = (ReturnSetInfo *) fcinfo->resultinfo;
	TupleDesc	fc_tupdesc;
	AttInMetadata *fc_attinmeta;
	MemoryContext fc_per_query_ctx;
	MemoryContext fc_oldcontext;

	/* 检查调用者是否支持我们返回 tupplestore */
	if (fc_rsinfo == NULL || !IsA(fc_rsinfo, ReturnSetInfo))
		ereport(ERROR,
				(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
				 errmsg("set-valued function called in context that cannot accept a set")));
	if (!(fc_rsinfo->allowedModes & SFRM_Materialize) ||
		fc_rsinfo->expectedDesc == NULL)
		ereport(ERROR,
				(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
				 errmsg("materialize mode required, but it is not allowed in this context")));

	if (fcinfo->nargs == 6)
	{
		fc_branch_delim = text_to_cstring(PG_GETARG_TEXT_PP(5));
		fc_show_branch = true;
	}
	else
		/* 默认是不显示，波浪号作为分隔符 */
		fc_branch_delim = pstrdup("~");

	fc_per_query_ctx = fc_rsinfo->econtext->ecxt_per_query_memory;
	fc_oldcontext = MemoryContextSwitchTo(fc_per_query_ctx);

	/* 获取请求的返回元组描述 */
	fc_tupdesc = CreateTupleDescCopy(fc_rsinfo->expectedDesc);

	/* 是否满足我们的需求 */
	fc_validateConnectbyTupleDesc(fc_tupdesc, fc_show_branch, fc_show_serial);

	/* 好的，那就用它 */
	fc_attinmeta = TupleDescGetAttInMetadata(fc_tupdesc);

	/* 好的，开始工作 */
	fc_rsinfo->returnMode = SFRM_Materialize;
	fc_rsinfo->setResult = fc_connectby(fc_relname,
								  fc_key_fld,
								  fc_parent_key_fld,
								  NULL,
								  fc_branch_delim,
								  fc_start_with,
								  fc_max_depth,
								  fc_show_branch,
								  fc_show_serial,
								  fc_per_query_ctx,
								  fc_rsinfo->allowedModes & SFRM_Materialize_Random,
								  fc_attinmeta);
	fc_rsinfo->setDesc = fc_tupdesc;

	MemoryContextSwitchTo(fc_oldcontext);

	/*
	 * SFRM_Materialize模式期望我们返回一个NULL Datum。实际
	 * 元组在我们的元组存储中，通过rsinfo->setResult返回。
	 * rsinfo->setDesc设置为我们实际用于构建元组的元组描述，
	 * 这样调用者可以验证我们所做的是否符合预期。
	 */
	return (Datum) 0;
}

PG_FUNCTION_INFO_V1(connectby_text_serial);
Datum connectby_text_serial(PG_FUNCTION_ARGS)
{
	char	   *fc_relname = text_to_cstring(PG_GETARG_TEXT_PP(0));
	char	   *fc_key_fld = text_to_cstring(PG_GETARG_TEXT_PP(1));
	char	   *fc_parent_key_fld = text_to_cstring(PG_GETARG_TEXT_PP(2));
	char	   *fc_orderby_fld = text_to_cstring(PG_GETARG_TEXT_PP(3));
	char	   *fc_start_with = text_to_cstring(PG_GETARG_TEXT_PP(4));
	int			fc_max_depth = PG_GETARG_INT32(5);
	char	   *fc_branch_delim = NULL;
	bool		fc_show_branch = false;
	bool		fc_show_serial = true;
	ReturnSetInfo *fc_rsinfo = (ReturnSetInfo *) fcinfo->resultinfo;
	TupleDesc	fc_tupdesc;
	AttInMetadata *fc_attinmeta;
	MemoryContext fc_per_query_ctx;
	MemoryContext fc_oldcontext;

	/* 检查调用者是否支持我们返回 tupplestore */
	if (fc_rsinfo == NULL || !IsA(fc_rsinfo, ReturnSetInfo))
		ereport(ERROR,
				(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
				 errmsg("set-valued function called in context that cannot accept a set")));
	if (!(fc_rsinfo->allowedModes & SFRM_Materialize) ||
		fc_rsinfo->expectedDesc == NULL)
		ereport(ERROR,
				(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
				 errmsg("materialize mode required, but it is not allowed in this context")));

	if (fcinfo->nargs == 7)
	{
		fc_branch_delim = text_to_cstring(PG_GETARG_TEXT_PP(6));
		fc_show_branch = true;
	}
	else
		/* 默认是不显示，波浪号作为分隔符 */
		fc_branch_delim = pstrdup("~");

	fc_per_query_ctx = fc_rsinfo->econtext->ecxt_per_query_memory;
	fc_oldcontext = MemoryContextSwitchTo(fc_per_query_ctx);

	/* 获取请求的返回元组描述 */
	fc_tupdesc = CreateTupleDescCopy(fc_rsinfo->expectedDesc);

	/* 是否满足我们的需求 */
	fc_validateConnectbyTupleDesc(fc_tupdesc, fc_show_branch, fc_show_serial);

	/* 好的，那就用它 */
	fc_attinmeta = TupleDescGetAttInMetadata(fc_tupdesc);

	/* 好的，开始工作 */
	fc_rsinfo->returnMode = SFRM_Materialize;
	fc_rsinfo->setResult = fc_connectby(fc_relname,
								  fc_key_fld,
								  fc_parent_key_fld,
								  fc_orderby_fld,
								  fc_branch_delim,
								  fc_start_with,
								  fc_max_depth,
								  fc_show_branch,
								  fc_show_serial,
								  fc_per_query_ctx,
								  fc_rsinfo->allowedModes & SFRM_Materialize_Random,
								  fc_attinmeta);
	fc_rsinfo->setDesc = fc_tupdesc;

	MemoryContextSwitchTo(fc_oldcontext);

	/*
	 * SFRM_Materialize模式期望我们返回一个NULL Datum。实际
	 * 元组在我们的元组存储中，通过rsinfo->setResult返回。
	 * rsinfo->setDesc设置为我们实际用于构建元组的元组描述，
	 * 这样调用者可以验证我们所做的是否符合预期。
	 */
	return (Datum) 0;
}


/*
 * connectby - 为 connectby_text() 做实际工作
 */
static Tuplestorestate * fc_connectby(char *fc_relname,
		  char *fc_key_fld,
		  char *fc_parent_key_fld,
		  char *fc_orderby_fld,
		  char *fc_branch_delim,
		  char *fc_start_with,
		  int fc_max_depth,
		  bool fc_show_branch,
		  bool fc_show_serial,
		  MemoryContext fc_per_query_ctx,
		  bool fc_randomAccess,
		  AttInMetadata *fc_attinmeta)
{
	Tuplestorestate *fc_tupstore = NULL;
	int			fc_ret;
	MemoryContext fc_oldcontext;

	int			fc_serial = 1;

	/* 连接到 SPI 管理器 */
	if ((fc_ret = SPI_connect()) < 0)
		/* 内部错误 */
		elog(ERROR, "connectby: SPI_connect returned %d", fc_ret);

	/* 切换到长期上下文以创建元组存储 */
	fc_oldcontext = MemoryContextSwitchTo(fc_per_query_ctx);

	/* 初始化我们的元组存储 */
	fc_tupstore = tuplestore_begin_heap(fc_randomAccess, false, work_mem);

	MemoryContextSwitchTo(fc_oldcontext);

	/* 现在去获取整个树 */
	fc_build_tuplestore_recursively(fc_key_fld,
								 fc_parent_key_fld,
								 fc_relname,
								 fc_orderby_fld,
								 fc_branch_delim,
								 fc_start_with,
								 fc_start_with,	/* 当前分支 */
								 0, /* 初始级别为 0 */
								 &fc_serial,	/* 初始序列为 1 */
								 fc_max_depth,
								 fc_show_branch,
								 fc_show_serial,
								 fc_per_query_ctx,
								 fc_attinmeta,
								 fc_tupstore);

	SPI_finish();

	return fc_tupstore;
}

static void fc_build_tuplestore_recursively(char *fc_key_fld,
							 char *fc_parent_key_fld,
							 char *fc_relname,
							 char *fc_orderby_fld,
							 char *fc_branch_delim,
							 char *fc_start_with,
							 char *fc_branch,
							 int fc_level,
							 int *fc_serial,
							 int fc_max_depth,
							 bool fc_show_branch,
							 bool fc_show_serial,
							 MemoryContext fc_per_query_ctx,
							 AttInMetadata *fc_attinmeta,
							 Tuplestorestate *fc_tupstore)
{
	TupleDesc	fc_tupdesc = fc_attinmeta->tupdesc;
	int			fc_ret;
	uint64		fc_proc;
	int			fc_serial_column;
	StringInfoData fc_sql;
	char	  **fc_values;
	char	   *fc_current_key;
	char	   *fc_current_key_parent;
	char		fc_current_level[INT32_STRLEN];
	char		fc_serial_str[INT32_STRLEN];
	char	   *fc_current_branch;
	HeapTuple	fc_tuple;

	if (fc_max_depth > 0 && fc_level > fc_max_depth)
		return;

	initStringInfo(&fc_sql);

	/* 构建初始 SQL 语句 */
	if (!fc_show_serial)
	{
		appendStringInfo(&fc_sql, "SELECT %s, %s FROM %s WHERE %s = %s AND %s IS NOT NULL AND %s <> %s",
						 fc_key_fld,
						 fc_parent_key_fld,
						 fc_relname,
						 fc_parent_key_fld,
						 quote_literal_cstr(fc_start_with),
						 fc_key_fld, fc_key_fld, fc_parent_key_fld);
		fc_serial_column = 0;
	}
	else
	{
		appendStringInfo(&fc_sql, "SELECT %s, %s FROM %s WHERE %s = %s AND %s IS NOT NULL AND %s <> %s ORDER BY %s",
						 fc_key_fld,
						 fc_parent_key_fld,
						 fc_relname,
						 fc_parent_key_fld,
						 quote_literal_cstr(fc_start_with),
						 fc_key_fld, fc_key_fld, fc_parent_key_fld,
						 fc_orderby_fld);
		fc_serial_column = 1;
	}

	if (fc_show_branch)
		fc_values = (char **) palloc((CONNECTBY_NCOLS + fc_serial_column) * sizeof(char *));
	else
		fc_values = (char **) palloc((CONNECTBY_NCOLS_NOBRANCH + fc_serial_column) * sizeof(char *));

	/* 第一次遍历，做一些设置 */
	if (fc_level == 0)
	{
		/* 根值是我们最初开始的值 */
		fc_values[0] = fc_start_with;

		/* 根值没有父节点 */
		fc_values[1] = NULL;

		/* 根级别为 0 */
		sprintf(fc_current_level, "%d", fc_level);
		fc_values[2] = fc_current_level;

		/* 根分支仅是开始的根值 */
		if (fc_show_branch)
			fc_values[3] = fc_start_with;

		/* 根从 1 开始序列 */
		if (fc_show_serial)
		{
			sprintf(fc_serial_str, "%d", (*fc_serial)++);
			if (fc_show_branch)
				fc_values[4] = fc_serial_str;
			else
				fc_values[3] = fc_serial_str;
		}

		/* 构造元组 */
		fc_tuple = BuildTupleFromCStrings(fc_attinmeta, fc_values);

		/* 现在存储它 */
		tuplestore_puttuple(fc_tupstore, fc_tuple);

		/* 增加级别 */
		fc_level++;
	}

	/* 获取所需的行 */
	fc_ret = SPI_execute(fc_sql.data, true, 0);
	fc_proc = SPI_processed;

	/* 检查符合条件的元组 */
	if ((fc_ret == SPI_OK_SELECT) && (fc_proc > 0))
	{
		HeapTuple	fc_spi_tuple;
		SPITupleTable *fc_tuptable = SPI_tuptable;
		TupleDesc	fc_spi_tupdesc = fc_tuptable->tupdesc;
		uint64		fc_i;
		StringInfoData fc_branchstr;
		StringInfoData fc_chk_branchstr;
		StringInfoData fc_chk_current_key;

		/*
		 * 检查返回的 tupdesc 是否与我们从查询中获得的兼容。
		 */
		fc_compatConnectbyTupleDescs(fc_tupdesc, fc_spi_tupdesc);

		initStringInfo(&fc_branchstr);
		initStringInfo(&fc_chk_branchstr);
		initStringInfo(&fc_chk_current_key);

		for (fc_i = 0; fc_i < fc_proc; fc_i++)
		{
			/* 为这个轮次初始化分支 */
			appendStringInfoString(&fc_branchstr, fc_branch);
			appendStringInfo(&fc_chk_branchstr, "%s%s%s", fc_branch_delim, fc_branch, fc_branch_delim);

			/* 获取下一个 SQL 结果元组 */
			fc_spi_tuple = fc_tuptable->vals[fc_i];

			/* 获取当前键（可能为 NULL） */
			fc_current_key = SPI_getvalue(fc_spi_tuple, fc_spi_tupdesc, 1);

			/* 获取父键（可能为 NULL） */
			fc_current_key_parent = SPI_getvalue(fc_spi_tuple, fc_spi_tupdesc, 2);

			/* 获取当前级别 */
			sprintf(fc_current_level, "%d", fc_level);

			/* 检查此键是否也是一个祖先 */
			if (fc_current_key)
			{
				appendStringInfo(&fc_chk_current_key, "%s%s%s",
								 fc_branch_delim, fc_current_key, fc_branch_delim);
				if (strstr(fc_chk_branchstr.data, fc_chk_current_key.data))
					ereport(ERROR,
							(errcode(ERRCODE_INVALID_RECURSION),
							 errmsg("infinite recursion detected")));
			}

			/* 好的，延展分支 */
			if (fc_current_key)
				appendStringInfo(&fc_branchstr, "%s%s", fc_branch_delim, fc_current_key);
			fc_current_branch = fc_branchstr.data;

			/* 构建一个元组 */ 
			fc_values[0] = fc_current_key;
			fc_values[1] = fc_current_key_parent;
			fc_values[2] = fc_current_level;
			if (fc_show_branch)
				fc_values[3] = fc_current_branch;
			if (fc_show_serial)
			{
				sprintf(fc_serial_str, "%d", (*fc_serial)++);
				if (fc_show_branch)
					fc_values[4] = fc_serial_str;
				else
					fc_values[3] = fc_serial_str;
			}

			fc_tuple = BuildTupleFromCStrings(fc_attinmeta, fc_values);

			/* 存储元组以备后用 */
			tuplestore_puttuple(fc_tupstore, fc_tuple);

			heap_freetuple(fc_tuple);

			/* 使用 current_key 作为新的 start_with 进行递归 */
			if (fc_current_key)
				fc_build_tuplestore_recursively(fc_key_fld,
											 fc_parent_key_fld,
											 fc_relname,
											 fc_orderby_fld,
											 fc_branch_delim,
											 fc_current_key,
											 fc_current_branch,
											 fc_level + 1,
											 fc_serial,
											 fc_max_depth,
											 fc_show_branch,
											 fc_show_serial,
											 fc_per_query_ctx,
											 fc_attinmeta,
											 fc_tupstore);

			xpfree(fc_current_key);
			xpfree(fc_current_key_parent);

			/* 重置分支以备下次使用 */
			resetStringInfo(&fc_branchstr);
			resetStringInfo(&fc_chk_branchstr);
			resetStringInfo(&fc_chk_current_key);
		}

		xpfree(fc_branchstr.data);
		xpfree(fc_chk_branchstr.data);
		xpfree(fc_chk_current_key.data);
	}
}

/*
 * 检查适合 Connectby 的预期（查询运行时）tupdesc
 */
static void fc_validateConnectbyTupleDesc(TupleDesc fc_td, bool fc_show_branch, bool fc_show_serial)
{
	int			fc_serial_column = 0;

	if (fc_show_serial)
		fc_serial_column = 1;

	/* 列数是否正确 */
	if (fc_show_branch)
	{
		if (fc_td->natts != (CONNECTBY_NCOLS + fc_serial_column))
			ereport(ERROR,
					(errcode(ERRCODE_DATATYPE_MISMATCH),
					 errmsg("invalid return type"),
					 errdetail("Query-specified return tuple has " \
							   "wrong number of columns.")));
	}
	else
	{
		if (fc_td->natts != CONNECTBY_NCOLS_NOBRANCH + fc_serial_column)
			ereport(ERROR,
					(errcode(ERRCODE_DATATYPE_MISMATCH),
					 errmsg("invalid return type"),
					 errdetail("Query-specified return tuple has " \
							   "wrong number of columns.")));
	}

	/* 检查前两列的类型是否匹配 */
	if (TupleDescAttr(fc_td, 0)->atttypid != TupleDescAttr(fc_td, 1)->atttypid)
		ereport(ERROR,
				(errcode(ERRCODE_DATATYPE_MISMATCH),
				 errmsg("invalid return type"),
				 errdetail("First two columns must be the same type.")));

	/* 检查第三列的类型是否为 INT4 */
	if (TupleDescAttr(fc_td, 2)->atttypid != INT4OID)
		ereport(ERROR,
				(errcode(ERRCODE_DATATYPE_MISMATCH),
				 errmsg("invalid return type"),
				 errdetail("Third column must be type %s.",
						   format_type_be(INT4OID))));

	/* 检查第四列的类型是否为 TEXT（如果适用） */
	if (fc_show_branch && TupleDescAttr(fc_td, 3)->atttypid != TEXTOID)
		ereport(ERROR,
				(errcode(ERRCODE_DATATYPE_MISMATCH),
				 errmsg("invalid return type"),
				 errdetail("Fourth column must be type %s.",
						   format_type_be(TEXTOID))));

	/* 检查第五列的类型是否为 INT4 */
	if (fc_show_branch && fc_show_serial &&
		TupleDescAttr(fc_td, 4)->atttypid != INT4OID)
		ereport(ERROR,
				(errcode(ERRCODE_DATATYPE_MISMATCH),
				 errmsg("query-specified return tuple not valid for Connectby: "
						"fifth column must be type %s",
						format_type_be(INT4OID))));

	/* 检查第四列的类型是否为 INT4 */
	if (!fc_show_branch && fc_show_serial &&
		TupleDescAttr(fc_td, 3)->atttypid != INT4OID)
		ereport(ERROR,
				(errcode(ERRCODE_DATATYPE_MISMATCH),
				 errmsg("query-specified return tuple not valid for Connectby: "
						"fourth column must be type %s",
						format_type_be(INT4OID))));

	/* 好的，这个 tupdesc 对我们的目的有效 */
}

/*
 * 检查 spi sql tupdesc 和返回的 tupdesc 是否兼容
 */
static void fc_compatConnectbyTupleDescs(TupleDesc fc_ret_tupdesc, TupleDesc fc_sql_tupdesc)
{
	Oid			fc_ret_atttypid;
	Oid			fc_sql_atttypid;
	int32		fc_ret_atttypmod;
	int32		fc_sql_atttypmod;

	/*
	 * 结果必须至少有 2 列。
	 */
	if (fc_sql_tupdesc->natts < 2)
		ereport(ERROR,
				(errcode(ERRCODE_DATATYPE_MISMATCH),
				 errmsg("invalid return type"),
				 errdetail("Query must return at least two columns.")));

	/*
	 * 这些列必须与调用查询指示的结果类型匹配。
	 */
	fc_ret_atttypid = TupleDescAttr(fc_ret_tupdesc, 0)->atttypid;
	fc_sql_atttypid = TupleDescAttr(fc_sql_tupdesc, 0)->atttypid;
	fc_ret_atttypmod = TupleDescAttr(fc_ret_tupdesc, 0)->atttypmod;
	fc_sql_atttypmod = TupleDescAttr(fc_sql_tupdesc, 0)->atttypmod;
	if (fc_ret_atttypid != fc_sql_atttypid ||
		(fc_ret_atttypmod >= 0 && fc_ret_atttypmod != fc_sql_atttypmod))
		ereport(ERROR,
				(errcode(ERRCODE_DATATYPE_MISMATCH),
				 errmsg("invalid return type"),
				 errdetail("SQL key field type %s does " \
						   "not match return key field type %s.",
						   format_type_with_typemod(fc_ret_atttypid, fc_ret_atttypmod),
						   format_type_with_typemod(fc_sql_atttypid, fc_sql_atttypmod))));

	fc_ret_atttypid = TupleDescAttr(fc_ret_tupdesc, 1)->atttypid;
	fc_sql_atttypid = TupleDescAttr(fc_sql_tupdesc, 1)->atttypid;
	fc_ret_atttypmod = TupleDescAttr(fc_ret_tupdesc, 1)->atttypmod;
	fc_sql_atttypmod = TupleDescAttr(fc_sql_tupdesc, 1)->atttypmod;
	if (fc_ret_atttypid != fc_sql_atttypid ||
		(fc_ret_atttypmod >= 0 && fc_ret_atttypmod != fc_sql_atttypmod))
		ereport(ERROR,
				(errcode(ERRCODE_DATATYPE_MISMATCH),
				 errmsg("invalid return type"),
				 errdetail("SQL parent key field type %s does " \
						   "not match return parent key field type %s.",
						   format_type_with_typemod(fc_ret_atttypid, fc_ret_atttypmod),
						   format_type_with_typemod(fc_sql_atttypid, fc_sql_atttypmod))));

	/* 好的，这两个 tupdesc 对我们的目的兼容 */
}

/*
 * 检查两个 tupdesc 在属性类型上是否匹配
 */
static bool fc_compatCrosstabTupleDescs(TupleDesc fc_ret_tupdesc, TupleDesc fc_sql_tupdesc)
{
	int			fc_i;
	Form_pg_attribute fc_ret_attr;
	Oid			fc_ret_atttypid;
	Form_pg_attribute fc_sql_attr;
	Oid			fc_sql_atttypid;

	if (fc_ret_tupdesc->natts < 2 ||
		fc_sql_tupdesc->natts < 3)
		return false;

	/* 检查 rowid 类型是否匹配 */
	fc_ret_atttypid = TupleDescAttr(fc_ret_tupdesc, 0)->atttypid;
	fc_sql_atttypid = TupleDescAttr(fc_sql_tupdesc, 0)->atttypid;
	if (fc_ret_atttypid != fc_sql_atttypid)
		ereport(ERROR,
				(errcode(ERRCODE_DATATYPE_MISMATCH),
				 errmsg("invalid return type"),
				 errdetail("SQL rowid datatype does not match " \
						   "return rowid datatype.")));

	/*
	 * - SQL 元组的属性 [1] 是类别；不需要检查 -
	 * SQL 元组的属性 [2] 应该与返回元组的属性 [1] 到 [natts] 匹配
	 */
	fc_sql_attr = TupleDescAttr(fc_sql_tupdesc, 2);
	for (fc_i = 1; fc_i < fc_ret_tupdesc->natts; fc_i++)
	{
		fc_ret_attr = TupleDescAttr(fc_ret_tupdesc, fc_i);

		if (fc_ret_attr->atttypid != fc_sql_attr->atttypid)
			return false;
	}

	/* 好的，这两个 tupdesc 对我们的目的兼容 */
	return true;
}
